/**
 *    Copyright (C) 2024-present MongoDB, Inc.
 *
 *    This program is free software: you can redistribute it and/or modify
 *    it under the terms of the Server Side Public License, version 1,
 *    as published by MongoDB, Inc.
 *
 *    This program is distributed in the hope that it will be useful,
 *    but WITHOUT ANY WARRANTY; without even the implied warranty of
 *    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 *    Server Side Public License for more details.
 *
 *    You should have received a copy of the Server Side Public License
 *    along with this program. If not, see
 *    <http://www.mongodb.com/licensing/server-side-public-license>.
 *
 *    As a special exception, the copyright holders give permission to link the
 *    code of portions of this program with the OpenSSL library under certain
 *    conditions as described in each individual source file and distribute
 *    linked combinations including the program with the OpenSSL library. You
 *    must comply with the Server Side Public License in all respects for
 *    all of the code used other than as permitted herein. If you modify file(s)
 *    with this exception, you may extend this exception to your version of the
 *    file(s), but you are not obligated to do so. If you do not wish to do so,
 *    delete this exception statement from your version. If you delete this
 *    exception statement from all source files in the program, then also delete
 *    it in the license file.
 */

#include "mongo/db/exec/classic/multi_plan.h"
#include "mongo/db/exec/runtime_planners/classic_runtime_planner/planner_interface.h"
#include "mongo/db/query/plan_yield_policy_impl.h"

namespace mongo::classic_runtime_planner {

MultiPlanner::MultiPlanner(PlannerData plannerData,
                           std::vector<std::unique_ptr<QuerySolution>> solutions,
                           QueryPlanner::PlanRankingResult planRankingResult)
    : ClassicPlannerInterface(std::move(plannerData), std::move(planRankingResult)) {
    auto stage = std::make_unique<MultiPlanStage>(
        cq()->getExpCtxRaw(),
        collections().getMainCollectionPtrOrAcquisition(),
        cq(),
        plan_cache_util::ClassicPlanCacheWriter{
            opCtx(), collections().getMainCollectionPtrOrAcquisition(), false /* executeInSbe */});
    for (auto&& solution : solutions) {
        solution->indexFilterApplied = plannerParams().indexFiltersApplied;
        auto executableTree = buildExecutableTree(*solution);
        stage->addPlan(std::move(solution), std::move(executableTree), ws());
    }
    setRoot(std::move(stage));
    // Need to do this after the move to make the static analyzer happy. The pointer is
    // stored as a PlanStage pointer, so we need to reinterpret cast during retrieval.
    _multiplanStage = reinterpret_cast<MultiPlanStage*>(getRoot());
}

Status MultiPlanner::doPlan(PlanYieldPolicy* planYieldPolicy) {
    return _multiplanStage->pickBestPlan(planYieldPolicy);
}

const MultiPlanStats* MultiPlanner::getSpecificStats() const {
    return static_cast<const MultiPlanStats*>(_multiplanStage->getSpecificStats());
}

Status MultiPlanner::runTrials(MultiPlanStage::TrialPhaseConfig trialConfig) {
    auto trialPeriodYieldPolicy = makeClassicYieldPolicy(
        opCtx(), cq()->nss(), static_cast<PlanStage*>(_multiplanStage), yieldPolicy());
    return _multiplanStage->runTrials(trialPeriodYieldPolicy.get(), trialConfig);
}

std::unique_ptr<QuerySolution> MultiPlanner::extractQuerySolution() {
    // The query solutions are owned by the 'MultiPlan' stage.
    return nullptr;
}
}  // namespace mongo::classic_runtime_planner
